<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>UniMRCP: apt_pollset.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">UniMRCP
   &#160;<span id="projectnumber">1.5.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_6719ab1f1f7655efc2fa43f7eb574fd1.html">libs</a></li><li class="navelem"><a class="el" href="dir_995e6b30ef7b7f0b2dec48039971ec97.html">apr-toolkit</a></li><li class="navelem"><a class="el" href="dir_af55bba262e1419c3a74fbffa32b25cc.html">include</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">apt_pollset.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Interruptable APR-Pollset.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;apr_poll.h&gt;</code><br/>
<code>#include &quot;<a class="el" href="apt_8h_source.html">apt.h</a>&quot;</code><br/>
</div>
<p><a href="apt__pollset_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:adc06ed2bb8da8477a1e63589b4253fed"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
typedefAPT_BEGIN_EXTERN_C <br class="typebreak"/>
struct <a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a></td></tr>
<tr class="separator:adc06ed2bb8da8477a1e63589b4253fed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a57216b0bb56d97b8656b7137ae1eb2d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apt__pollset_8h.html#a57216b0bb56d97b8656b7137ae1eb2d5">apt_pollset_create</a> (apr_uint32_t size, apr_pool_t *pool)</td></tr>
<tr class="separator:a57216b0bb56d97b8656b7137ae1eb2d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0714bc087b71c2d21d56576ae328ace"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apt__pollset_8h.html#ac0714bc087b71c2d21d56576ae328ace">apt_pollset_destroy</a> (<a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *pollset)</td></tr>
<tr class="separator:ac0714bc087b71c2d21d56576ae328ace"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a102083e76cc5320e7d8b316ff4eeff9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apt__pollset_8h.html#a102083e76cc5320e7d8b316ff4eeff9e">apt_pollset_add</a> (<a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *pollset, const apr_pollfd_t *descriptor)</td></tr>
<tr class="separator:a102083e76cc5320e7d8b316ff4eeff9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a704f1f1f9ce3863245d865d37645419f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apt__pollset_8h.html#a704f1f1f9ce3863245d865d37645419f">apt_pollset_remove</a> (<a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *pollset, const apr_pollfd_t *descriptor)</td></tr>
<tr class="separator:a704f1f1f9ce3863245d865d37645419f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36b69e16ffd4f7c1a4e5f3257a999396"><td class="memItemLeft" align="right" valign="top">apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apt__pollset_8h.html#a36b69e16ffd4f7c1a4e5f3257a999396">apt_pollset_poll</a> (<a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *pollset, apr_interval_time_t timeout, apr_int32_t *num, const apr_pollfd_t **descriptors)</td></tr>
<tr class="separator:a36b69e16ffd4f7c1a4e5f3257a999396"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7f5c27d83138f3fe2ed8b1eb00a80c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apt__pollset_8h.html#ac7f5c27d83138f3fe2ed8b1eb00a80c1">apt_pollset_wakeup</a> (<a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *pollset)</td></tr>
<tr class="separator:ac7f5c27d83138f3fe2ed8b1eb00a80c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0794c2841cc1ab4152cb2351435d3e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apt__pollset_8h.html#ab0794c2841cc1ab4152cb2351435d3e0">apt_pollset_is_wakeup</a> (<a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *pollset, const apr_pollfd_t *descriptor)</td></tr>
<tr class="separator:ab0794c2841cc1ab4152cb2351435d3e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interruptable APR-Pollset. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="adc06ed2bb8da8477a1e63589b4253fed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef typedefAPT_BEGIN_EXTERN_C struct <a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> <a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Wakeup builtin API of the pollset is introduced only in APR-1.4 and it is not available for APR-1.2 and APR-1.3 versions. Thus apt_pollset_t is an extension of apr_pollset_t and provides pollset wakeup capabilities the similar way as it's implemented in APR-1.4 trunkOpaque pollset declaration </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a102083e76cc5320e7d8b316ff4eeff9e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> apt_pollset_add </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *&#160;</td>
          <td class="paramname"><em>pollset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const apr_pollfd_t *&#160;</td>
          <td class="paramname"><em>descriptor</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Add pollset descriptor to a pollset. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pollset</td><td>the pollset to add the descriptor to </td></tr>
    <tr><td class="paramname">descriptor</td><td>the descriptor to add </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a57216b0bb56d97b8656b7137ae1eb2d5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a>* apt_pollset_create </td>
          <td>(</td>
          <td class="paramtype">apr_uint32_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">apr_pool_t *&#160;</td>
          <td class="paramname"><em>pool</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create interruptable pollset on top of APR pollset. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>the maximum number of descriptors pollset can hold </td></tr>
    <tr><td class="paramname">pool</td><td>the pool to allocate memory from </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac0714bc087b71c2d21d56576ae328ace"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> apt_pollset_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *&#160;</td>
          <td class="paramname"><em>pollset</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Destroy pollset. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pollset</td><td>the pollset to destroy </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ab0794c2841cc1ab4152cb2351435d3e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> apt_pollset_is_wakeup </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *&#160;</td>
          <td class="paramname"><em>pollset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const apr_pollfd_t *&#160;</td>
          <td class="paramname"><em>descriptor</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Match against builtin wake up descriptor in a pollset. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pollset</td><td>the pollset to use </td></tr>
    <tr><td class="paramname">descriptor</td><td>the descriptor to match </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a36b69e16ffd4f7c1a4e5f3257a999396"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">apr_status_t apt_pollset_poll </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *&#160;</td>
          <td class="paramname"><em>pollset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">apr_interval_time_t&#160;</td>
          <td class="paramname"><em>timeout</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">apr_int32_t *&#160;</td>
          <td class="paramname"><em>num</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const apr_pollfd_t **&#160;</td>
          <td class="paramname"><em>descriptors</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Block for activity on the descriptor(s) in a pollset. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pollset</td><td>the pollset to use </td></tr>
    <tr><td class="paramname">timeout</td><td>the timeout in microseconds </td></tr>
    <tr><td class="paramname">num</td><td>the number of signalled descriptors (output parameter) </td></tr>
    <tr><td class="paramname">descriptors</td><td>the array of signalled descriptors (output parameter) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a704f1f1f9ce3863245d865d37645419f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> apt_pollset_remove </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *&#160;</td>
          <td class="paramname"><em>pollset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const apr_pollfd_t *&#160;</td>
          <td class="paramname"><em>descriptor</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Remove pollset descriptor from a pollset. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pollset</td><td>the pollset to remove the descriptor from </td></tr>
    <tr><td class="paramname">descriptor</td><td>the descriptor to remove </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac7f5c27d83138f3fe2ed8b1eb00a80c1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="apt_8h.html#ac7b6d8df47829d778eb598e1cc52cc2a">apt_bool_t</a> apt_pollset_wakeup </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="apt__pollset_8h.html#adc06ed2bb8da8477a1e63589b4253fed">apt_pollset_t</a> *&#160;</td>
          <td class="paramname"><em>pollset</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Interrupt the blocked poll call. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pollset</td><td>the pollset to use </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Aug 22 2017 10:11:48 for UniMRCP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
